Structure and title updates #229
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
danbarr
force-pushed
the
update-filenames
branch
from
4b71c09 to
28504dd
Compare
Signed-off-by: Dan Barr <[email protected]>
It's only used in one place Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
See facebook/docusaurus#9808 (comment) Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
danbarr
force-pushed
the
update-filenames
branch
from
98de978 to
321e785
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the documentation structure by standardizing file extensions to .mdx, updating page titles for consistency, and reorganizing content for better navigation. The changes aim to improve documentation maintainability and user experience.
Key changes:
- Standardizes all documentation files to use
.mdxextension (except auto-generated files) - Updates page titles and sidebar structure for better organization
- Adds redirects for renamed pages to prevent broken links
- Improves accessibility with better aria-labels and cross-references
Reviewed Changes
Copilot reviewed 38 out of 44 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| vercel.json | Adds redirects for renamed pages to maintain URL compatibility |
| sidebars.ts | Restructures navigation with better categorization and updated file references |
| docusaurus.config.ts | Improves accessibility with descriptive aria-labels for social media links |
| Multiple .mdx files | Updates cross-references to use .mdx extensions and improves content organization |
Comments suppressed due to low confidence (1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Some structural polishing and refactoring:
.mdxfor consistency and less confusion (excluding auto-generated files pulled from the app repo)Related issues/PRs
N/A
Screenshots
New structure/titles in guides sections:
Merge checklist
Content
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviews
Signed-off-by: Dan Barr [email protected]